/*
 //@HEADER
 // ************************************************************************
 //
 //                        Kokkos v. 3.0
//       Copyright (2020) National Technology & Engineering
//               Solutions of Sandia, LLC (NTESS).
 //
 // Under the terms of Contract DE-NA0003525 with NTESS,
 // the U.S. Government retains certain rights in this software.
 //
 // Redistribution and use in source and binary forms, with or without
 // modification, are permitted provided that the following conditions are
 // met:
 //
 // 1. Redistributions of source code must retain the above copyright
 // notice, this list of conditions and the following disclaimer.
 //
 // 2. Redistributions in binary form must reproduce the above copyright
 // notice, this list of conditions and the following disclaimer in the
 // documentation and/or other materials provided with the distribution.
 //
 // 3. Neither the name of the Corporation nor the names of the
 // contributors may be used to endorse or promote products derived from
 // this software without specific prior written permission.
 //
 // THIS SOFTWARE IS PROVIDED BY NTESS "AS IS" AND ANY
 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NTESS OR THE
 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 //
 // Questions? Contact Christian R. Trott (crtrott@sandia.gov)
 //
 // ************************************************************************
 //@HEADER
 */

#ifndef KOKKOSP_INTERFACE_HPP
#define KOKKOSP_INTERFACE_HPP

#include <Kokkos_Macros.hpp>
#include <cinttypes>
#include <cstddef>
#include <Kokkos_Core_fwd.hpp>
#include <string>

#include <iostream>
#include <cstdlib>

// NOTE: in this Kokkos::Profiling block, do not define anything that shouldn't
// exist should Profiling be disabled

namespace Kokkos {
namespace Profiling {
namespace Experimental {
enum struct DeviceType {
  Serial,
  OpenMP,
  Cuda,
  HIP,
  OpenMPTarget,
  HPX,
  Threads
};
template <typename ExecutionSpace>
struct DeviceTypeTraits;

constexpr const size_t device_type_bits = 8;
constexpr const size_t instance_bits    = 24;
template <typename ExecutionSpace>
inline uint32_t device_id(ExecutionSpace const& space) noexcept {
  auto device_id = static_cast<uint32_t>(DeviceTypeTraits<ExecutionSpace>::id);
  return (device_id << instance_bits) + space.impl_instance_id();
}
}  // namespace Experimental
}  // namespace Profiling
}  // end namespace Kokkos

#if defined(KOKKOS_ENABLE_PROFILING)
// We check at configure time that libdl is available.
#include <dlfcn.h>

#include <impl/Kokkos_Profiling_DeviceInfo.hpp>

#define KOKKOSP_INTERFACE_VERSION 20171029

namespace Kokkos {
namespace Profiling {

struct SpaceHandle {
  SpaceHandle(const char* space_name);
  char name[64];
};

typedef void (*initFunction)(const int, const uint64_t, const uint32_t,
                             KokkosPDeviceInfo*);
typedef void (*finalizeFunction)();
typedef void (*beginFunction)(const char*, const uint32_t, uint64_t*);
typedef void (*endFunction)(uint64_t);

typedef void (*pushFunction)(const char*);
typedef void (*popFunction)();

typedef void (*allocateDataFunction)(const SpaceHandle, const char*,
                                     const void*, const uint64_t);
typedef void (*deallocateDataFunction)(const SpaceHandle, const char*,
                                       const void*, const uint64_t);

typedef void (*createProfileSectionFunction)(const char*, uint32_t*);
typedef void (*startProfileSectionFunction)(const uint32_t);
typedef void (*stopProfileSectionFunction)(const uint32_t);
typedef void (*destroyProfileSectionFunction)(const uint32_t);

typedef void (*profileEventFunction)(const char*);

typedef void (*beginDeepCopyFunction)(SpaceHandle, const char*, const void*,
                                      SpaceHandle, const char*, const void*,
                                      uint64_t);
typedef void (*endDeepCopyFunction)();

bool profileLibraryLoaded();

void beginParallelFor(const std::string& kernelPrefix, const uint32_t devID,
                      uint64_t* kernelID);
void endParallelFor(const uint64_t kernelID);
void beginParallelScan(const std::string& kernelPrefix, const uint32_t devID,
                       uint64_t* kernelID);
void endParallelScan(const uint64_t kernelID);
void beginParallelReduce(const std::string& kernelPrefix, const uint32_t devID,
                         uint64_t* kernelID);
void endParallelReduce(const uint64_t kernelID);

void pushRegion(const std::string& kName);
void popRegion();

void createProfileSection(const std::string& sectionName, uint32_t* secID);
void startSection(const uint32_t secID);
void stopSection(const uint32_t secID);
void destroyProfileSection(const uint32_t secID);

void markEvent(const std::string* evName);

void allocateData(const SpaceHandle space, const std::string label,
                  const void* ptr, const uint64_t size);
void deallocateData(const SpaceHandle space, const std::string label,
                    const void* ptr, const uint64_t size);

void beginDeepCopy(const SpaceHandle dst_space, const std::string dst_label,
                   const void* dst_ptr, const SpaceHandle src_space,
                   const std::string src_label, const void* src_ptr,
                   const uint64_t size);
void endDeepCopy();

void initialize();
void finalize();

}  // namespace Profiling
}  // namespace Kokkos

#else
namespace Kokkos {
namespace Profiling {

struct SpaceHandle {
  SpaceHandle(const char* space_name);
  char name[64];
};

bool profileLibraryLoaded();

void beginParallelFor(const std::string&, const uint32_t, uint64_t*);
void endParallelFor(const uint64_t);
void beginParallelScan(const std::string&, const uint32_t, uint64_t*);
void endParallelScan(const uint64_t);
void beginParallelReduce(const std::string&, const uint32_t, uint64_t*);
void endParallelReduce(const uint64_t);

void pushRegion(const std::string&);
void popRegion();
void createProfileSection(const std::string&, uint32_t*);
void startSection(const uint32_t);
void stopSection(const uint32_t);
void destroyProfileSection(const uint32_t);

void markEvent(const std::string&);

void allocateData(const SpaceHandle, const std::string, const void*,
                  const uint64_t);
void deallocateData(const SpaceHandle, const std::string, const void*,
                    const uint64_t);

void beginDeepCopy(const SpaceHandle, const std::string, const void*,
                   const SpaceHandle, const std::string, const void*,
                   const uint64_t);
void endDeepCopy();

void initialize();
void finalize();

}  // namespace Profiling
}  // namespace Kokkos

#endif
#endif
